This repository has been archived by the owner on Oct 28, 2022. It is now read-only.

Add cmdlets to change cli Settings of ESG #439

Merged

dcoghlan merged 17 commits into vmware-archive:master from alagoutte:cliSettings

Aug 13, 2019

Contributor

alagoutte commented Dec 7, 2017

Add 2 new cmdlets for get and set cliSettings of ESG (or DLR)

Fix #431

Contributor Author

alagoutte commented Dec 7, 2017

There is not yet testsuite but i will be follow soon

alagoutte force-pushed the cliSettings branch from d5195e8 to d5a4a48 Compare

December 21, 2017 21:44

Contributor Author

alagoutte commented Dec 21, 2017 •

edited

Loading

Hi,

Now with testsuite (and also add a testsuite for Enable/DisableSSH)

Can you review/check ?

Contributor Author

alagoutte commented Jan 9, 2018

jenkins test this please

Contributor

nmbradford commented Jan 23, 2018

Hi Alexis - sorry for the large delay responding - only getting a chance to actually catch up on PowerNSX backlog now. Ive taken a quick look at the merge - and a few things occur.

Firstly - I think this should be a part of set-nsxedge rather than separate cmdlets. I recently did some policy work and as an example, check out how set-nsxsecuritypolicy works - it can either accept updated XML, OR explicitly update specific properties. best of both worlds. I think this is the model that all set-xxx cmdlets should use now. To that end, set-nsxedge already does the first (Accepts updated XML) and I think this an all related base (appliance, cli etc) edge config should be handled here too. So your code should be pretty much copy/paste to update set-nsxedge... and your tests should be easy to move too...

Contributor

nmbradford commented Jan 23, 2018

Ill add a few other minor comments in review too...

nmbradford suggested changes

View reviewed changes

module/PowerNSX.psm1 Show resolved Hide resolved

module/PowerNSX.psm1 Show resolved Hide resolved

module/PowerNSX.psm1

+                  for load balancer, site‐to‐site VPN, and NAT services.
+                  The Set-NsxcliSettings cmdlet configure the cli Settings of the ESG
+                  it is mandatory to specified the password...

Contributor

nmbradford Jan 23, 2018

Why? any other edge xml update doesnt require this? are you saying no cli settings can be updated unless credential is specified? I havent tested this yet, but it sounds wrong.

Contributor Author

alagoutte Jan 23, 2018

Try and you will see that... (may be crazy when see that...)

Contributor

nmbradford Jan 23, 2018

i tested updating the banner text with the clisettings api - and yes it rejects it without credentials, however, i also tried it by updating the full edge api - and it works fine. Another reason for including in set-nsxedge :D

module/PowerNSX.psm1 Outdated Show resolved Hide resolved

module/PowerNSX.psm1 Outdated Show resolved Hide resolved

tests/integration/04.Edge.Tests.ps1 Outdated

@@ @@ -660,6 +660,67 @@ Describe "Edge" { @@
                       }
                   }
+                  Context "SSH" {

Contributor

nmbradford Jan 23, 2018

Great that you are adding tests, but why are you including ssh tests here? should be separate PR...

Contributor Author

alagoutte Jan 23, 2018

Ok
it is already a separate commit... (i see this issue when write my testsuite...)

Contributor

nmbradford Jan 23, 2018

its because you aren't branching from master. you should use master to track upstream, branch from it for every isolated PR you intend to raise. For this case, dont worry - as long as the PR tests pass when we execute the full suite against it

tests/integration/04.Edge.Tests.ps1 Outdated

+                          #When deploy pstester ESG, the SSH is enabled
+                          $edge.cliSettings.remoteAccess | should be "true"
+                          #Need Always to set a password to change cliSettings
+                          Get-NsxEdge $name | Get-NsxcliSettings | Set-NsxCliSettings -password Vmware1!Vmware1! -remoteAccess:$false

Contributor

nmbradford Jan 23, 2018

you havent tested get-nsxclisettings yet - you need prior test that tests this (and you should use it two lines above too!) - this will probably be a moot point if you move these functions to set-nsxedge though...

Contributor Author

alagoutte Jan 23, 2018

do you have a example ?

Contributor

nmbradford Jan 23, 2018

all the other tests that test retrieval first.

tests/integration/04.Edge.Tests.ps1 Outdated

+                      it "Change (SSH) username" {
+                          $edge = Get-NsxEdge $name
+                          #By default it is admin
+                          $edge.cliSettings.userName | should be "admin"

Contributor

nmbradford Jan 23, 2018

if we dont rely on it, then no point in testing for it...

tests/integration/04.Edge.Tests.ps1 Outdated

+                      it "Change Password Expiry" {
+                          $edge = Get-NsxEdge $name
+                          #By default it is 99999
+                          $edge.cliSettings.passwordExpiry | should be "99999"

Contributor

nmbradford Jan 23, 2018

likewise

tests/integration/04.Edge.Tests.ps1 Outdated

+                          $edge = Get-NsxEdge $name
+                          #By default it is 99999
+                          $edge.cliSettings.passwordExpiry | should be "99999"
+                          Get-NsxEdge $name | Get-NsxcliSettings | Set-NsxCliSettings -password Vmware1!Vmware1! -passwordExpiry 42

Contributor

nmbradford Jan 23, 2018

haha! :D

Contributor Author

alagoutte commented Jan 23, 2018

not sure it is a good idea to include on set-nsxedge it will be a big cmdlets with a lot of parameter..
and when there is some direct API, it is better to use ? (and more faster ? like send all nsx-edge info)

or for rename to *-NsxEdgecliSettings !

Contributor

nmbradford commented Jan 23, 2018 •

edited

Loading

Lots of parameters aren't a problem, as long as the code is clean and the invocation is not confusing for users. I don't see anything here that is an issue. Also - given the comment inline about the fact that you can use the full edge api to update clisettings, i think it makes more sense in set-nsxedge.

Contributor Author

alagoutte commented Jan 24, 2018

Move all set-nsxclisettings to set-nsxedge and remove get-nsxclisettings (or always kept ?)

Contributor

nmbradford commented Jan 24, 2018

if you think its needed, im not opposed to having get-nsx_edge_clisettings, but given you can just go (get-nsxedge fred).cliSettings, I'm not sure I see the value! :D

Contributor Author

alagoutte commented Jan 24, 2018 •

edited

Loading

Ok, i will update my patches soon...

Can you look some other (small) PR (like #454 #455 #456 )

alagoutte mentioned this pull request

Tests(Edge): Add SSH Context #463

Merged

alagoutte force-pushed the cliSettings branch 2 times, most recently from 97bc7a5 to 77b6cc1 Compare

January 30, 2018 22:20

Contributor Author

alagoutte commented Jan 30, 2018

Updated (test suite and some other change)

it is better ?

Contributor

nmbradford commented Jan 30, 2018

password is still mandatory - it needs to not be, I showed you how to avoid that requirement in the API, and it is still a separate cmdlet for set - it needs to be part of set-nsxedge as previously commented.

alagoutte mentioned this pull request

Set-NsxLoadBalancer: use $variable.ToString().ToLower() instead of th… #465

Closed

Contributor Author

alagoutte commented Jan 31, 2018

i ask about test suite if it is good...

alagoutte force-pushed the cliSettings branch 3 times, most recently from bc346a6 to 70465fa Compare

February 5, 2018 19:31

Contributor Author

alagoutte commented Feb 5, 2018

Hi @nmbradford, can you look ?

it is add now on set-nsxedge (but kept set-clisettings...)

alagoutte force-pushed the cliSettings branch from 70465fa to f50032e Compare

February 6, 2018 06:54

Contributor Author

alagoutte commented Feb 25, 2018

@nmbradford any news ?

Contributor

nmbradford commented Mar 15, 2018

looks a lot better (havent had a chance to review the tests yet, but the changes in Set-NsxEdge look good.

What is still a problem is that you have (nearly) duplicate code in Set-CliSettings (which is still also called the wrong thing as it doesnt include the word edge in it.) and still has a mandatory password.

Get-CliSettings is also called the wrong thing.

You need to either
a) Remove Get/Set-CliSettings (what value does it serve over Get/Set-NsxEdge now?)
b) Rename and modify Get/Set-CliSettings 👍 (include the word edge). Remove duplicate code (call set-NsxEdge internally rather than doing the same thing twice. Make password non-mandatory.

Contributor Author

alagoutte commented Mar 15, 2018

i will look to avoid duplicate code

I prefer to kept name Get/set-nsxCliSettings because i can be also working for DLR.. (and not also Edge)
and for other Edge Feature, there is not Edge on cmdlets..

Contributor

nmbradford commented Mar 15, 2018

There is a CLI in NSX other than edge/dlr so this wont be ok. If you are adamant about keeping a cli specific cmdlet, please name it as requested. Create a second set of cmdlets that are DLR specific that also wraps the same cmd. As repeatedly stated, my preference is for there to be no cli specific cmdlets. This is yet another reason for that.

alagoutte force-pushed the cliSettings branch from f50032e to 0353e3b Compare

March 16, 2018 11:08

Contributor Author

alagoutte commented Mar 16, 2018

Remove [Get|Set]-nsxCliSettings and only kept Set-NsxEdge with cliSettings

powernsxbot commented Aug 7, 2019

Tests Failed

alagoutte and others added 16 commits

August 8, 2019 15:30


          cliSettings: Add Get-NsxcliSettings cmdlets

80e47b2


          cliSettings: Add Set-NsxcliSettings cmdlet

d3f4e5b


          cliSettings: Add Edge Tests suites

1842e13

for Get/Set-NsxCliSettings


          cliSettings: fix typo on examples

ab5d543

the SSH username need to be only lowercase
and fix missing example for -passwordExpiry


          cliSettings: Remove (kill) whitespace

48399b5


          cliSettings: use $variable.ToString().ToLower() instead of the if/else

1da0749


          cliSettings: Always check there is XML node before change value

4df8029


          cliSettings (Tests): Check before it is possible to retrieve cliSettings

31fc204


          cliSettings: Add cliSettings to Set-NsxEdge


          cliSettings: Add testsuite (via Set-NsxEdge)

b96366c


          cliSettings: You need to change on the sametime userName and Password...

09bf088

Bug or feature ?


          cliSettings: Add example for cliSettings with Set-NsxEdge

927dc14


          cliSettings: Remove test-suite for [Get|Set]-NsxcliSettings

9af0e78


          cliSettings: Remove [Get|Set]-NsxcliSettings

225dc21

use Set-NsxEdge for modify cliSettings


          Updated edge test to fix failures

42b4005

fixed correct usage of $null


          Set-NsxEdge(cliSettings): fix passwordExpiry (need to be ToString())

0a4544f

alagoutte force-pushed the cliSettings branch from c6ff81d to 0a4544f Compare

August 8, 2019 13:31

Contributor Author

alagoutte commented Aug 8, 2019

it is ok ?

Contributor

dcoghlan commented Aug 9, 2019

jenkins test this please

powernsxbot commented Aug 10, 2019

Tests Failed

dcoghlan reviewed

View reviewed changes

module/PowerNSX.psm1

+                      if ( $PsBoundParameters.ContainsKey('passwordExpiry') ) {
+                          if ( invoke-xpathquery -node $_Edge -querymethod SelectSingleNode -Query "child::cliSettings/passwordExpiry" ) {
+                              $_Edge.cliSettings.passwordExpiry = $passwordExpiry

Contributor

dcoghlan Aug 10, 2019

This also needs to be cast as a string.

Contributor Author

alagoutte Aug 12, 2019

Done

Contributor Author

alagoutte Aug 12, 2019

On what release it don't work ? (because work for me on Windows with PowerShell 6/Core

Contributor

dcoghlan Aug 13, 2019

needs to work on Powershell 5.1 on Windows

Contributor

dcoghlan commented Aug 12, 2019

jenkins test this please


          Set-NsxEdge(cliSettings): fix passwordExpiry (need to be ToString())

65290c1

Part 2...

alagoutte force-pushed the cliSettings branch from 1601f35 to 65290c1 Compare

August 12, 2019 10:53

powernsxbot commented Aug 12, 2019

Tests Failed

Contributor

dcoghlan commented Aug 13, 2019

jenkins test this please

powernsxbot commented Aug 13, 2019

Tests Failed

Contributor

dcoghlan commented Aug 13, 2019

CLI tests have passed now. Overall tests failed due to cleanup error, so this one is good to go now.

dcoghlan merged commit 05a8bff into vmware-archive:master

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet